Use Codecov Uploader instead of Bash uploader #19

paymand · 2022-05-23T15:00:19Z

Support for the Bash Uploader, as you can see on the page, is deprecated on February 1st, 2022. Even though it still seems to work fine, I think it will eventually be sunset at some point.

The idea is to use Codecov Uploader.

Also see the blog post below for more info:
https://about.codecov.io/blog/introducing-codecovs-new-uploader/

I have updated the tests and they pass:

➜  codecov-buildkite-plugin git:(codecov_uploader) ✗ docker-compose run --rm tests
Creating codecov-buildkite-plugin_tests_run ... done
 ✓ Post-command succeeds
 ✓ Post-command succeeds with arguments
 ✓ Post-command succeeds with -Z
 ✓ Post-command is skipped if command failed and skip_on_fail=true
 ✓ Pre-exit succeeds

5 tests, 0 failures

I haven't actually tested the upload, but I will try to test it on a branch.

joscha · 2022-05-23T21:57:49Z

Great! It's about time to replace the bahs based uploader - can you make sure that the plugin still works as expected on a variety of hosts? The bash uploader had very few dependencies. I haven't looked at your PR in detail but I saw an APK call somewhere for example, which we can't easily make a prerequisite possibly.

paymand · 2022-05-24T09:39:07Z

I saw an APK call somewhere for example, which we can't easily make a prerequisite possibly.

Added support for MacOS and other Linux flavors here: 97431ea

paymand · 2022-05-24T09:39:44Z

can you make sure that the plugin still works as expected on a variety of hosts?

Will test this and let you know.

paymand · 2022-05-24T16:41:44Z

@joscha works for me on our buildkite pipeline. Tested it with one of our projects and the coverage files are uploaded correctly. Feel free to give it a spin if you have the possibility.

joscha

Thanks for this! I haven't been able to test it as I don't currently have a codecov project available to me.

joscha · 2022-05-24T22:07:31Z

hooks/post-command

@@ -47,6 +176,9 @@ main() {
  local ci_env
  ci_env=$(bash <(curl -s -S --connect-timeout 10 --retry 3 --retry-delay 10 https://codecov.io/env))

+  codecov_command=./codecov
+  get_codecov_uploader


This means that on each run a new uploader is downloaded; always latest currently. I wonder if we can allow a fixed version set by the plugin config and then cache away that particular version. Similar to what is done here: https://github.com/joscha/sauce-connect-buildkite-plugin/blob/master/hooks/pre-command#L30

That way the uploader stays stable longer and does not rely on the network fetch each time nor will cause trouble (read massive amounts of requests) when there are many many builds run from one subnet.

Fixed in 388c47d
I have added two new configs: uploader_version and tmp_dir with proper defaults.
The downloaded binary will be cached accordingly.

joscha · 2022-05-24T22:09:47Z

hooks/post-command

@@ -25,6 +25,135 @@ plugin_read_list_into_result() {
  [[ ${#result[@]} -gt 0 ]] || return 1
 }

+
+get_os() {


Given that the uploader is only available for plain Linux, alpine and Macos (and windows which we don't currently support) can we simplify this one? If it just returned the strings linux, alpine or macos we can feed that directly into the download URL

Fixed in 388c47d

joscha · 2022-05-24T22:11:28Z

hooks/post-command

+  local os=$(get_os)
+  local os_array=($os)
+  if [ -n ${os_array[1]} ] && [ ${os_array[1]} = "Alpine" ]; then
+    apk add gnupg


Does an alpine allow this install on the fly?

well, in my test it seems to be working:

➜ codecov-buildkite-plugin git:(codecov_uploader) docker run -it alpine:3.14 / # gpg /bin/sh: gpg: not found / # apk add gnupg Installing gnupg (2.2.31-r0) Executing busybox-1.33.1-r7.trigger OK: 25 MiB in 42 packages / # gpg --version gpg (GnuPG) 2.2.31 libgcrypt 1.9.4 Copyright (C) 2021 Free Software Foundation, Inc. License GNU GPL-3.0-or-later <https://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. Home: /root/.gnupg Supported algorithms: Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH, CAMELLIA128, CAMELLIA192, CAMELLIA256 Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224 Compression: Uncompressed, ZIP, ZLIB, BZIP2

joscha · 2022-05-24T22:12:09Z

hooks/post-command

+    curl -Os https://uploader.codecov.io/latest/linux/codecov
+    curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM
+    curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM.sig
+    gpgv codecov.SHA256SUM.sig codecov.SHA256SUM


This makes gpg a prereq for the plugin. We should name it in the plugin.yml

Fixed in 388c47d

paymand · 2022-05-25T17:08:00Z

hooks/post-command

-  [[ ${#result[@]} -gt 0 ]] || return 1
-}
+script_path="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+source "${script_path}/../lib/utils.bash"


mmm, this fails on CI:

/var/lib/buildkite-agent/plugins/github-com-peakon-codecov-buildkite-plugin-uploader/hooks/post-command: line 5: /tmp/../lib/utils.bash: No such file or directory

@joscha any idea how to do this? I moved the common code to another file, because I needed to use some of the code in the tests...

yeah, I remember solving this before. I can't find a code reference right now, but I remember two ways:

You can stub builtins via the method outlined in Stubbing out functions sstephenson/bats#38 (comment) (local definition + export -f)

Or what I remember to be the better way:

set a variable in your script where you want to include the file:

REPO_DIR="$(git rev-parse --show-toplevel)"

which will always give you the plugin root (as it is a valid checkout) and then include the file via:

source "${REPO_DIR}/lib/utils.bash"

in your bats test you can then just stub out the call to git to return the right path:

REPO_DIR="${BATS_TEST_DIRNAME}/../.." setup() { stub git "rev-parse --show-toplevel : echo ${REPO_DIR}" }

mmm, I did try the second suggestion, but git rev-parse --show-toplevel gets the path to the root of our checked out project on the agent and tries to include lib/utils.bash which obviously doesn't exist there and it fails. I think I'll go with the first solution: bringing back the extracted code to post-command and stubbing the required code in the tests.

plugin.yml

paymand · 2022-05-27T11:42:54Z

@joscha would you mind doing another review? I have tested on CI and it works fine. Also tried with uploader_version: v0.2.3 and tmp_dir: /tmp/foo as you can see below:

gpg: key ED779869: public key "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>" imported
gpg: Total number processed: 1
gpg:               imported: 1  (RSA: 1)
/tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov
https://uploader.codecov.io/v0.2.3/linux/codecov
/tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov.SHA256SUM
https://uploader.codecov.io/v0.2.3/linux/codecov.SHA256SUM
/tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov.SHA256SUM.sig
https://uploader.codecov.io/v0.2.3/linux/codecov.SHA256SUM.sig
gpgv: Signature made Tue 17 May 2022 01:25:03 PM UTC using RSA key ID ED779869
gpgv: Good signature from "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>"
codecov: OK
[2022-05-27T11:33:45.384Z] ['info'] 
     _____          _
    / ____|        | |
   | |     ___   __| | ___  ___ _____   __
   | |    / _ \ / _` |/ _ \/ __/ _ \ \ / /
   | |___| (_) | (_| |  __/ (_| (_) \ V /
    \_____\___/ \__,_|\___|\___\___/ \_/

  Codecov report uploader 0.2.3

joscha · 2022-06-02T14:23:43Z

Hi @paymand, thanks for all the updates. Looking pretty good now! If I pushed a few changes to the bash code, would you be able to run your test on the combined code by any chance?

paymand · 2022-06-03T07:29:13Z

@joscha yes, I can. Please push your changes and I'll test it.

joscha · 2022-06-03T13:04:28Z

@joscha yes, I can. Please push your changes and I'll test it.

Pushed them here: peakon#6 - mainly shellcheck, a few other minor changes

…e-plugin into codecov_uploader

fixes

joscha · 2022-06-06T20:23:24Z

hooks/post-command

+  do
+    local local_path="${TMP_DIR}/${file}"
+    if [[ ! -e "${local_path}" ]]; then
+      >&2 echo "Local path will be: ${local_path}"


Suggested change

>&2 echo "Local path will be: ${local_path}"

debug "Local path will be: ${local_path}"

Fixed in 827e857.

joscha · 2022-06-06T20:23:44Z

hooks/post-command

+    if [[ ! -e "${local_path}" ]]; then
+      >&2 echo "Local path will be: ${local_path}"
+      local remote_source="https://uploader.codecov.io/${CODECOV_VERSION}/${OS}/${file}"
+      >&2 echo "Source is: ${remote_source}"


Suggested change

>&2 echo "Source is: ${remote_source}"

debug "Source is: ${remote_source}"

Fixed in 827e857.

paymand · 2022-06-07T07:17:01Z

@joscha Got it tested and it works fine:

gpg: key ED779869: public key "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>" imported
gpg: Total number processed: 1
gpg:               imported: 1  (RSA: 1)
Local path will be: /tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov
Source is: https://uploader.codecov.io/v0.2.3/linux/codecov
Local path will be: /tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov.SHA256SUM
Source is: https://uploader.codecov.io/v0.2.3/linux/codecov.SHA256SUM
Local path will be: /tmp/foo/codecov-buildkite-plugin/linux/v0.2.3/codecov.SHA256SUM.sig
Source is: https://uploader.codecov.io/v0.2.3/linux/codecov.SHA256SUM.sig
gpgv: Signature made Tue 17 May 2022 01:25:03 PM UTC using RSA key ID ED779869
gpgv: Good signature from "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>"
codecov: OK
Unable to find image 'buildpack-deps:jessie-scm' locally
jessie-scm: Pulling from library/buildpack-deps
Digest: sha256:f1d9fcc8ad402af3b095cdec22a9dd6f0dbba630eab7b0f032c842ecafdaceb9
Status: Downloaded newer image for buildpack-deps:jessie-scm
[2022-06-07T07:12:37.912Z] ['info'] 
     _____          _
    / ____|        | |
   | |     ___   __| | ___  ___ _____   __
   | |    / _ \ / _` |/ _ \/ __/ _ \ \ / /
   | |___| (_) | (_| |  __/ (_| (_) \ V /
    \_____\___/ \__,_|\___|\___\___/ \_/

  Codecov report uploader 0.2.3

joscha · 2022-06-07T07:30:25Z

Nice work!

paymand · 2022-06-07T07:31:37Z

Also tested without uploader_version and tmp_dir:

gpg: key ED779869: "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>" not changed
gpg: Total number processed: 1
gpg:              unchanged: 1
Local path will be: /tmp/codecov-buildkite-plugin/linux/latest/codecov
Source is: https://uploader.codecov.io/latest/linux/codecov
Local path will be: /tmp/codecov-buildkite-plugin/linux/latest/codecov.SHA256SUM
Source is: https://uploader.codecov.io/latest/linux/codecov.SHA256SUM
Local path will be: /tmp/codecov-buildkite-plugin/linux/latest/codecov.SHA256SUM.sig
Source is: https://uploader.codecov.io/latest/linux/codecov.SHA256SUM.sig
gpgv: Signature made Tue 17 May 2022 01:25:03 PM UTC using RSA key ID ED779869
gpgv: Good signature from "Codecov Uploader (Codecov Uploader Verification Key) <security@codecov.io>"
codecov: OK
[2022-06-07T07:27:48.563Z] ['info'] 
     _____          _
    / ____|        | |
   | |     ___   __| | ___  ___ _____   __
   | |    / _ \ / _` |/ _ \/ __/ _ \ \ / /
   | |___| (_) | (_| |  __/ (_| (_) \ V /
    \_____\___/ \__,_|\___|\___\___/ \_/

  Codecov report uploader 0.2.3

Good to merge IMHO 👍

Use Codecov Uploader instead of Bash uploader

7237b32

Add support for MacOS and other Linux flavors

97431ea

paymand added 2 commits May 24, 2022 15:57

Fix for a bug found when testing on CI

6e26233

Use sha256sum on Linux

c3967a6

joscha reviewed May 24, 2022

View reviewed changes

paymand added 2 commits May 25, 2022 17:47

Address issues raised in PR review

388c47d

Fix an issue found on CI

9ed5682

paymand force-pushed the codecov_uploader branch from f236cd6 to 9ed5682 Compare May 25, 2022 16:33

paymand commented May 25, 2022

View reviewed changes

paymand requested a review from joscha May 25, 2022 17:08

joscha reviewed May 26, 2022

View reviewed changes

plugin.yml Show resolved Hide resolved

paymand added 4 commits May 27, 2022 09:39

Use git rev-parse to get plugin root

d36fd2d

Stub required code in tests

554942a

Mount /tmp volume

c38cebf

Remove redundant requirement

dad3b1c

paymand requested a review from joscha May 27, 2022 20:07

fixes

c65a89d

joscha and others added 5 commits June 4, 2022 07:40

Update hooks/post-command

5ce5d84

Update plugin.yml

e2e4b45

partial revert

92d2a04

Merge branch 'codecov_uploader' of github.com:joscha/codecov-buildkit…

14d4e22

…e-plugin into codecov_uploader

Merge pull request #6 from joscha/codecov_uploader

c5bd3cb

fixes

joscha approved these changes Jun 6, 2022

View reviewed changes

Use the new debug function

827e857

joscha merged commit 3af774b into joscha:master Jun 7, 2022

joscha mentioned this pull request Jun 7, 2022

Add codecov bash script SHA verification #12

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Codecov Uploader instead of Bash uploader #19

Use Codecov Uploader instead of Bash uploader #19

paymand commented May 23, 2022

joscha commented May 23, 2022

paymand commented May 24, 2022 •

edited

Loading

paymand commented May 24, 2022

paymand commented May 24, 2022

joscha left a comment

joscha May 24, 2022

paymand May 25, 2022

joscha May 24, 2022

paymand May 25, 2022

joscha May 24, 2022

paymand May 25, 2022

joscha May 24, 2022

paymand May 25, 2022

paymand May 25, 2022

joscha May 26, 2022

paymand May 27, 2022 •

edited

Loading

paymand commented May 27, 2022

joscha commented Jun 2, 2022

paymand commented Jun 3, 2022

joscha commented Jun 3, 2022

joscha Jun 6, 2022

paymand Jun 7, 2022

joscha Jun 6, 2022

paymand Jun 7, 2022

paymand commented Jun 7, 2022 •

edited

Loading

joscha commented Jun 7, 2022

paymand commented Jun 7, 2022

	>&2 echo "Local path will be: ${local_path}"
	debug "Local path will be: ${local_path}"

	>&2 echo "Source is: ${remote_source}"
	debug "Source is: ${remote_source}"

Use Codecov Uploader instead of Bash uploader #19

Use Codecov Uploader instead of Bash uploader #19

Conversation

paymand commented May 23, 2022

joscha commented May 23, 2022

paymand commented May 24, 2022 • edited Loading

paymand commented May 24, 2022

paymand commented May 24, 2022

joscha left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paymand May 27, 2022 • edited Loading

Choose a reason for hiding this comment

paymand commented May 27, 2022

joscha commented Jun 2, 2022

paymand commented Jun 3, 2022

joscha commented Jun 3, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paymand commented Jun 7, 2022 • edited Loading

joscha commented Jun 7, 2022

paymand commented Jun 7, 2022

paymand commented May 24, 2022 •

edited

Loading

paymand May 27, 2022 •

edited

Loading

paymand commented Jun 7, 2022 •

edited

Loading